startEchoTest method Null safety

Future<int?> startEchoTest(
  1. {required EchoTestConfig config,
  2. required int delayTime}
)

开启音视频回路测试

在进房前,用户可调用该接口对音视频通话全链路进行检测,包括对音视频设备以及用户上下行网络的检测,从而帮助用户判断是否可以正常发布和接收音视频流。
开始检测后,SDK 会录制你声音或视频。如果你在设置的延时范围内收到了回放,则视为音视频回路测试正常。

delayTime 为音视频延迟播放的时间间隔,用于指定在开始检测多长时间后期望收到回放。取值范围为 2,10,单位为秒,默认为 2 秒。

返回值:方法调用结果

  • 0:成功
  • -1:失败,当前用户已经在检测中
  • -3:失败,音视频均未采集
  • -4:失败,参数异常
  • -5:失败,已经存在相同 roomId 的房间

注意:

  • 调用该方法开始音视频回路检测后,你可以调用 RTCVideo.stopEchoTest 立即结束测试,也可等待测试 60s 后自动结束,以更换设备进行下一次测试,或进房。
  • 在该方法之前调用的所有跟设备控制、流控制相关的方法均在开始检测时失效,在结束检测后恢复生效。
  • 在调用 RTCVIdeo.startEchoTest 和 RTCVIdeo.stopEchoTest 之间调用的所有跟设备采集、流控制、进房相关的方法均不生效,并会收到 RTCVideoEventHandler.onWarning 回调。
  • 音视频回路检测的结果会通过 RTCVideoEventHandler.onEchoTestResult 回调通知。

Implementation

Future<int?> startEchoTest({
  required EchoTestConfig config,
  required int delayTime,
});